﻿// Copyright 2009 Mike Geise
// 
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// 
//     http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

namespace Falcon.Core.Domain.Repositories
{
	using Falcon.Core.Collections;

	public interface IUserBadgeRepository
	{
		/// <summary>
		/// Gets the user badge by the specified specification.
		/// </summary>
		/// <param name="specification">The <see cref="UserBadgeSpecification"/>.</param>
		UserBadge GetBy(UserBadgeSpecification specification);

		/// <summary>
		/// Gets the user badge by the specified id.
		/// </summary>
		/// <param name="id">The id.</param>
		UserBadge GetById(int id);

		/// <summary>
		/// Gets all the users badges by the specified specification.
		/// </summary>
		/// <param name="specification">The <see cref="UserBadgeSpecification"/>.</param>
		IPagedList<UserBadge, UserBadgeSpecification> GetPaged(UserBadgeSpecification specification);

		/// <summary>
		/// Gets all the users badges with the user by the specified specification.
		/// </summary>
		/// <param name="specification">The <see cref="UserBadgeSpecification"/>.</param>
		IPagedList<UserBadge, UserBadgeSpecification> GetUsers(UserBadgeSpecification specification);

		/// <summary>
		/// Gets all the users badges grouped by the specified specification.
		/// </summary>
		/// <param name="specification">The <see cref="UserBadgeSpecification"/>.</param>
		IPagedList<UserBadge, UserBadgeSpecification> GetGrouped(UserBadgeSpecification specification);

		/// <summary>
		/// Inserts the specified badge.
		/// </summary>
		/// <param name="badge">The badge.</param>
		void Insert(UserBadge badge);

		/// <summary>
		/// Updates the specified badge.
		/// </summary>
		/// <param name="badge">The badge.</param>
		void Update(UserBadge badge);

		/// <summary>
		/// Deletes the specified badge.
		/// </summary>
		/// <param name="badge">The badge.</param>
		void Delete(UserBadge badge);
	}
}